home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / program / manview.zoo / manview.1 < prev    next >
Encoding:
Text File  |  1994-01-31  |  10.9 KB  |  223 lines
  1. MANVIEW(1)               User commands                  MANVIEW(1)
  2.  
  3. NAME
  4.      manview - display manual pages using GEM windows
  5.  
  6.  
  7. SYNOPSIS
  8.      manview { [section] pagename }
  9.  
  10.  
  11. DESCRIPTION
  12.      Manview is used to view manual pages in a GEM-conforming
  13.      fashion. This is useful especially under a multitasking
  14.      environment. It is possible to view multiple manual pages
  15.      at the same time as well as using the usual cross references
  16.      easily.
  17.  
  18.      As the program can be started with or without arguments, there
  19.      are two different behaviors for these cases:
  20.      If the program is started without arguments, a small dialog in
  21.      a window will show up, with the three buttons "Quit", "Hide",
  22.      "Manual Page". The "Quit" button terminates the complete program,
  23.      the "Manual Page" button opens an additional manual window, and
  24.      the "Hide" button - if enabled - removes this dialog; it is
  25.      enabled as long as at least one manual window is open and the
  26.      dialog is popped up after closing the last manual window. (See
  27.      the paragraph about environment variables to modify this
  28.      behavior)
  29.  
  30.      If the program is started with arguments the dialog window is
  31.      not shown at all and will never show up. Instead a manual window
  32.      will be opened, showing the desired manual page if it could be
  33.      found (otherwise it will remain empty).
  34.  
  35.      The manual windows contain each a menu and an area where the text
  36.      is to be shown. The menu bar has two menu items "Options" and
  37.      "Sections" and a status part, where the name of the current page
  38.      is displayed. The menu works only on demand, that means that it
  39.      has to be clicked upon to drop the menu down; after that it can
  40.      be used while holding down the mouse button or by releasing it
  41.      and selecting a menu item by clicking onto it.
  42.      In the "Sections" menu the current manual section can be chosen,
  43.      i.e. section 1 to see the user commands. If there is a selection
  44.      made the text area will show rows of names of all manual pages
  45.      found in that section with the possibility to choose one of them
  46.      with the mouse (if there are subsections like section 1m for
  47.      built-in mupfel commands, these are indicated behind the name of
  48.      the manual page).
  49.      The "Options" menu gives various possibilities: open new manual
  50.      windows, remove the current manual window, switch the display
  51.      mode between current manual page and current section listing
  52.      and search a specific manual page or search for a word in the
  53.      current one. It is also possible to quit the entire program via
  54.      menu or force a rescan of all the manual pages in case that some
  55.      of the used directory structures have changed (See paragraph
  56.      "Environment" for details).
  57.      For the search a dialog will show up where the searched item
  58.      can be entered. It has three buttons: "Cancel", "Keyword" and
  59.      "Global". The "Global" button is used for searching a manual
  60.      page, whereas the "Keyword" button is used to activate a
  61.      keyword search in the current manual page.
  62.  
  63.      If manview detects at start time that there is already a copy
  64.      of itself running in the system, it sends a message to that copy
  65.      to display the manual pages given as arguments. (Of course this
  66.      feature can only work if there is a multitasking AES installed,
  67.      like Atari's MultiTOS.) Unfortunately, there are some older AES
  68.      system which do multitasking applications but do not provide the
  69.      necessary services for this feature. For users of these systems
  70.      an additional program named showman is provided, which does
  71.      basically the same, but also works under these older systems.
  72.  
  73.      The manual windows have two different operation modes: one mode
  74.      displays a manual page, the second displays the complete listing 
  75.      of all the manual pages of a given section. In this mode, a mouse
  76.      click on the name of a manual page loads this page and displays it
  77.      in this window (this feature has a more general background, see 
  78.      the chapter about advanced mouse usage below).
  79.  
  80.  
  81. ADVANCED MOUSE USAGE
  82.      All windows of manview can be operated while not being the top
  83.      window if the system's AES does allow that (this behavior can
  84.      be triggered with an environment variable, see below).
  85.      If manview is running on a system that provides a MultiTOS
  86.      compatible Drag & Drop protocoll, it is possible to drag an item 
  87.      onto one of manview's windows and it is tried to find and load 
  88.      the appropriate manual page; if the item is dragged onto the 
  89.      dialog window, a new window is opened for that page. As a second
  90.      possibility for drag & drop some basic functions of the VA
  91.      protocoll are supplied.
  92.      Another feature is that if the user clicks onto a word in the
  93.      text area of such a window, manview tries to find and load an
  94.      appropriate manual page. If at the time of the click the ALT
  95.      key is pressed, the new manual page (if found) is displayed
  96.      in a new window.
  97.  
  98.  
  99. KEYBOARD USAGE
  100.      Whenever a button in a dialog (in a window or not does not
  101.      matter) has an underlined character, it is possible to
  102.      operate this button by pressing this character while holding
  103.      down the ALT key.
  104.      There are keyboard shortcuts for some of the menu items:
  105.         control-f      Search
  106.         control-d      Display listing of current section
  107.         control-m      Display current manual page
  108.         control-n      Open an additional manual window
  109.         control-h,
  110.         control-u      Close the current manual window
  111.         control-a      Show some copying and version information
  112.         control-q      Quit the program
  113.  
  114.      There are several other keys supported:
  115.         control-w      top the bottom window
  116.         up             Scroll the window contents up
  117.         down           Scroll downward
  118.         f, d, <space>,
  119.         shift-down     Go one page down
  120.         b, u,
  121.         shift-up       Go one page up
  122.         home           Go to the top line
  123.         shift-home     Go to the bottom line
  124.         control-g      Continue a keyword search at the current
  125.                        position with the same keyword
  126.  
  127. ARGUMENT LINE
  128.      Manview supports also command line arguments, which have to be 
  129.      according to the following syntax:
  130.  
  131.        manview { [section] pagename }
  132.  
  133.      The support for section numbers is very useful if there are several
  134.      manual pages with the same name, which can happen very easily on a
  135.      file system that does not support case snesitive file names, like
  136.      the normal TOS file system, where 'fopen' and 'Fopen' are the same.
  137.  
  138.      Example: manview 1 cookie 1m export 3 fopen
  139.        tries to display the manual pages cookie in section 1, export in
  140.        section 1m (a subsection of section 1) and fopen in section 3.
  141.  
  142.  
  143.  
  144. ENVIRONMENT
  145.      Manview uses five environment variables:
  146.        MANPATH - this is the most important variable, as it controls
  147.           where the manual pages are searched. The paths are to be
  148.           separated by ',' or ';'. (The normal conventions for giving
  149.           drive numbers are supported: both c:\man and /dev/c/man
  150.           give the same result, folder man on drive c). Each of these
  151.           paths gives a folder, in which several other folders can be
  152.           found. For these, there are two possibilities: named cat*,
  153.           the folder contains manual pages which are already
  154.           translated into ascii format (with control characters) by
  155.           nroff(1). The other possibility is doc*, in which case the
  156.           folder contains manual pages in the 1st Word+ format.
  157.           The first character right after "cat" or "doc" denominates
  158.           the capter number of the manual page, i.e. cat1 and cat1m
  159.           both contain manuals in chapter one.
  160.           Example: export MANPATH=\usr\man,\usr\local\man
  161.              in \usr\man could be found:
  162.              cat1    manuals for user commands
  163.              cat2    manual for system calls, i.e. from the MiNT
  164.                      distribution
  165.              cat3    manuals of library calls
  166.              cat4    manuals for device drivers
  167.              cat5    manuals of the different file formats
  168.              cat6    descriptions of games
  169.              cat7    miscellaneous manuals
  170.              cat8    system administration manual pages
  171.           If this variable does not exist or contains nothing useful,
  172.           the program tries the default value "\usr\man".
  173.  
  174.        MANVIEW_FONT - name of the VDI font to use for the manual
  175.           windows. The name must be written in exactly the same
  176.           way as the VDI does, otherwise it won't be recognized.
  177.           The default font is the system font with id 1.
  178.           Example: export MANVIEW_FONT='Gemini'
  179.  
  180.        MANVIEW_FONTID - if looking for the font given in $MANVIEW_FONT
  181.           was not successful or that variable does not exist, it is
  182.           tried to extract a numerical font id from this variable for
  183.           the font for the manual windows.
  184.           Example: export MANVIEW_FONTID='79'
  185.  
  186.        MANVIEW_FONTSIZE - gives the size for the font in the manual
  187.           windows. The unit Points (pt) is used. Default is 10pt.
  188.           Example: export MANVIEW_FONTSIZE='9'
  189.  
  190.        MANVIEW_SETTINGS - controls some of the behavior of manview.
  191.           This variable (if used) contains strings, which override
  192.           default settings. The strings are separated by ':', ';'
  193.           or any other character which does not occur in the
  194.           following strings:
  195.           "auto_hilight" makes manview automatically print those lines
  196.                    in bold face which contain only upper case letters.
  197.                    Use this to increase the readability of ASCII-only
  198.                    manual pages. Default is off.
  199.           "no_main_win" the starting dialog will never show up, even
  200.                    if no arguments are given. Instead a manual window
  201.                    is opened, but it might be empty. The default is that
  202.                    the starting dialog is popped up if there are no
  203.                    arguments given.
  204.           "check_files" when searching for manual pages, check each
  205.                    file found whether it is a regular file. Otherwise
  206.                    don't treat it as a manual page. This is useful
  207.                    if one has folders in the manual directories - they
  208.                    dont show up as manual pages. Unfortunately, this
  209.                    test is quite slow, so the default is to skip it.
  210.           "bg_usable" all windows are also usable while not being the
  211.                    front window. This function is not available for
  212.                    all AES versions.
  213.           Example: MANVIEW_SETTINGS='no_main_win:auto_hilight'
  214.  
  215.  
  216. AUTHOR
  217.      Ulrich Kühn
  218.      eMail: kuehn@math.uni-muenster.de
  219.  
  220.  
  221. SEE ALSO
  222.      nroff(1), showman(1)
  223.